User Manual


Table of Contents


System Requirements

Minimum System Requirements

Installation & Setup

  1. Download the Application

  2. Verify File Integrity

  3. No Installation Required

alt text

Source Code Version (For Developers)

  1. Clone the Repository

  2. Install Dependencies

  3. Check Installation


Getting Started

Launching the Application

  1. Standard Launch

  2. Verifying Successful Launch

alt text

Understanding the Initial State

When the application starts:

🟢 Success Indicator: You should see two elevator cars positioned at Floor 1 with closed doors and no directional arrows lit.

Quick Start Tutorial

Follow these steps for your first interaction:

  1. Call an Elevator

  2. Select a Destination

  3. Manual Door Control

🔵 Tip: Doors will automatically close after a few seconds if left open.


User Interface Overview

Main Window Layout

The application window consists of four main sections arranged for optimal usability:

alt text

A. Building Visualization (Top)

B. Elevator Control Panels (Middle)

C. Status Information (Bottom)

D. Debug Information (Bottom) [Optional]

Building Visualization Details

Floor Layout:

Elevator Cars:

Call Buttons:

Control Panel Features

Each elevator has an identical control panel containing:

Floor Selection Buttons:

Door Control Buttons:

Status Display:

alt text

Debug Information Panel

🔵 Note: Debug information is hidden by default. Enable it using the --debug command line option.

The debug panel provides technical details:


Basic Operations

Calling an Elevator

Purpose: Summon an elevator to your current floor

Steps:

  1. Identify your current floor on the building visualization
  2. Determine your intended direction (up or down)
  3. Click the appropriate call button:
  4. Wait for the elevator to arrive (button will remain lit)
  5. The button will reset when an elevator reaches your floor

Example Scenario:

⚠️ Important: Always select the correct direction button. Elevators optimize their routes based on the direction of your call.

Selecting Your Destination

Purpose: Choose which floor you want to visit

Steps:

  1. Ensure you're "inside" an elevator (doors are open at your floor)
  2. Look at the control panel for the appropriate elevator
  3. Click the button corresponding to your destination floor
  4. The button will light up to confirm your selection
  5. The elevator will automatically close doors and move to your destination

Multiple Destinations:

Floor Button Reference:

alt text

Manual Door Control

Purpose: Override automatic door operations

When to Use:

Open Doors Manually:

  1. Click the "◀ ▶" button in the elevator control panel
  2. Doors will open immediately
  3. Doors will remain open until manually closed or timeout occurs

Close Doors Manually:

  1. Click the "▶ ◀" button in the elevator control panel
  2. Doors will close immediately
  3. If elevator has destinations, movement will begin automatically

🔴 Safety Note: Manual door controls only work when the elevator is stopped at a floor. Moving elevators cannot have doors opened.

Command Line Options

The application supports several command line parameters for advanced users and system administrators.

Basic Command Line Usage

Opening Command Prompt:

  1. Press Windows + R to open Run dialog
  2. Type cmd and press Enter
  3. Navigate to the application directory using cd command
  4. Run the application with desired options

Basic Syntax:

elevator.exe [OPTIONS]

Available Options

--debug

--headless

--ws-port [PORT]

--http-port [PORT]

--zmq-port [PORT]

--console

Common Command Line Examples

Debug Mode for Troubleshooting:

elevator.exe --debug --console

Headless Mode for Server:

elevator.exe --headless --http-port 8080

Custom Port Configuration:

elevator.exe --ws-port 18680 --http-port 19095

Full Debug with Custom Ports:

elevator.exe --debug --console --ws-port 18675 --http-port 19090

🔵 Tip: Command line options are particularly useful for system administrators or when running multiple instances of the application.